.TH "Zebulon::NMEA::Message" 3 "13 Oct 2009" "Version 2" "zebulon" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Zebulon::NMEA::Message \- 
.PP
\fBMessage\fP class for creating \fBNMEA\fP message structures.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <message.h>\fP
.PP
Inherited by \fBZebulon::NMEA::GPGGA\fP, and \fBZebulon::NMEA::GPGLL\fP.
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBTime\fP"
.br
.RI "\fI\fBTime\fP structure for logging when a message was created/generated. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBMessage\fP (const Message::Type type, const std::string &header)"
.br
.ti -1c
.RI "virtual int \fBGetPosition\fP (CxUtils::Wgs &pos) const =0"
.br
.ti -1c
.RI "virtual int \fBGetUTC\fP (double &utc) const =0"
.br
.ti -1c
.RI "virtual unsigned int \fBWrite\fP (CxUtils::Packet &msg) const =0"
.br
.ti -1c
.RI "virtual unsigned int \fBRead\fP (const CxUtils::Packet &msg)=0"
.br
.ti -1c
.RI "virtual \fBMessage\fP * \fBClone\fP () const =0"
.br
.ti -1c
.RI "void \fBSetMessageTimeStamp\fP (const \fBMessage::Time\fP t)"
.br
.ti -1c
.RI "virtual void \fBPrint\fP () const "
.br
.ti -1c
.RI "\fBMessage::Time\fP \fBGetMessageTimeStamp\fP () const "
.br
.ti -1c
.RI "Message::Type \fBGetType\fP () const "
.br
.ti -1c
.RI "std::string \fBGetHeader\fP () const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static int \fBRunTestCase\fP ()"
.br
.ti -1c
.RI "static bool \fBIsValidMessage\fP (const CxUtils::Packet &msg)"
.br
.ti -1c
.RI "static bool \fBExtractMessage\fP (const unsigned char *buff, const unsigned int len, CxUtils::Packet &msg, std::string *header=NULL)"
.br
.ti -1c
.RI "static bool \fBWriteChecksum\fP (CxUtils::Packet &msg)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBCopyMessageData\fP (const \fBMessage\fP *msg)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBTime\fP \fBmTimeStamp\fP"
.br
.RI "\fI\fBTime\fP of message creation. \fP"
.in -1c
.SH "Detailed Description"
.PP 
\fBMessage\fP class for creating \fBNMEA\fP message structures. 

Methods you must overload are:
.br
 GetPosition - If the message has World Geodetic Systems (WGS) position data return 1, and save values to Wgs structure. If not supported, return 0.
.br
 Write - Write data members to a Packet in the correct \fBNMEA\fP format.
.br
 Read - Read data in supported \fBNMEA\fP format and save to internal data members.
.br
 GetUTC - If message has UTC data, then return 1 and copy to input parameter, otherwise return 0. Clone - Make a copy of your message and return pointer to it. 
.br
.PP
Optional methods to overload:
.br
 RunTestCase - Perform a test of your message class. Return 1 on success and 0 on failure.
.br
 

.SH "Author"
.PP 
Generated automatically by Doxygen for zebulon from the source code.
